Resource OperationDefinition/FHIR Server from package nictiz.fhir.nl.stu3.iwlz#1.0.0-poc8 (78 ms)

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "iwlz-Indicaties",
  "url" : "http://nictiz.nl/fhir/OperationDefinition/iwlz-Indicaties",
  "name" : "Retrieve Indicatiebesluiten",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "publisher" : "Nictiz",
  "contact" : [
    {
      "name" : "Nictiz",
      "telecom" : [
        {
          "system" : "email",
          "value" : "info@nictiz.nl",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "This operation is used to return all 'indicatiebesluiten' Composition resources and referenced information related to a patient. This operation assumes that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient. Otherwise, the use of the `patient` parameter might be required. The response is a bundle of type \"searchset\". Included in the bundle are all Composition resources representing 'indicatiebesluiten' associated with the patient (with `entry.search.mode` set to 'match') and _all_ resources referenced by the Composition resources and by the referenced resources themselves (with `entry.search.mode` set to 'include'). All resources SHALL conform to the profiles defined by the information standard ['iWlz'](https://informatiestandaarden.nictiz.nl/wiki/MedMij:Vpoc_1.0/OntwerpiWlz). If there are no 'indicatiebesluit' related resources, this operation SHALL return an empty bundle, preferably containing an OperationOutcome resource.",
  "purpose" : "The Composition/$document operation is only suitable for retrieving one specific Composition and all its referenced resources. This operation enables the simultaneous search and retrieval of one or more Compositions and its referenced resources in one interaction. Discussions on generalization and specification of this use case are ongoing (see `OperationDefinition.comment`).",
  "code" : "indicaties",
  "comment" : "While initially the $document operation (https://www.hl7.org/fhir/stu3/composition-operations.html#document) was to be used, its text left many ambiguity on the exact use of the operation and if it would be allowed to use for a simultaneous search and 'resolve' operation. A discussion within the FHIR community (see https://jira.hl7.org/browse/FHIR-36699) led to the conclusion that $document is not meant to be used this way and that its definition is going to be clarified in future FHIR versions. Discussions are ongoing within the Structured Documents Working Group if a new operation that supports the search and retrieval of multiple document Compositions shall be proposed. This operation SHALL be revoked in the future if this core operation is accepted.",
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The id of a patient resource located on the server on which this operation is executed.        This paramater is not be necessary for use in MedMij because all RESTful actions are perfomed in the context of a specific authenticated patient, for which an OAuth2 token has been retrieved using the authentication mechanisms described in the 'Afsprakenstelsel'.        Each XIS Gateway is required to perform filtering based on the patient associated with the OAuth2 token received for the request, so that only the records associated with the authenticated patient are returned.        Therefore, no parameters should be passed for patient identification.",
      "type" : "Identifier"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "All 'indicatiebesluiten' Composition associated with the patient, including all resources referenced in the Compositions and its referenced profiles. The bundle type is \"searchset\".",
      "type" : "Bundle"
    }
  ],
  "text" : {
  }
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.